<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.configuration.beanutils;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.Map;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    /**<a name="line.21"></a>
<FONT color="green">022</FONT>     * &lt;p&gt;<a name="line.22"></a>
<FONT color="green">023</FONT>     * Definition of an interface for declaring a bean in a configuration file.<a name="line.23"></a>
<FONT color="green">024</FONT>     * &lt;/p&gt;<a name="line.24"></a>
<FONT color="green">025</FONT>     * &lt;p&gt;<a name="line.25"></a>
<FONT color="green">026</FONT>     * Commons Configurations allows to define beans (i.e. simple Java objects) in<a name="line.26"></a>
<FONT color="green">027</FONT>     * configuration files, which can be created at runtime. This is especially<a name="line.27"></a>
<FONT color="green">028</FONT>     * useful if you program against interfaces and want to define the concrete<a name="line.28"></a>
<FONT color="green">029</FONT>     * implementation class is a configuration file.<a name="line.29"></a>
<FONT color="green">030</FONT>     * &lt;/p&gt;<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * This interface defines methods for retrieving all information about a bean<a name="line.32"></a>
<FONT color="green">033</FONT>     * that should be created from a configuration file, e.g. the bean's properties<a name="line.33"></a>
<FONT color="green">034</FONT>     * or the factory to use for creating the instance. With different<a name="line.34"></a>
<FONT color="green">035</FONT>     * implementations different &amp;quot;layouts&amp;quot; of bean declarations can be<a name="line.35"></a>
<FONT color="green">036</FONT>     * supported. For instance if an XML configuration file is used, all features of<a name="line.36"></a>
<FONT color="green">037</FONT>     * XML (e.g. attributes, nested elements) can be used to define the bean. In a<a name="line.37"></a>
<FONT color="green">038</FONT>     * properties file the declaration format is more limited. The purpose of this<a name="line.38"></a>
<FONT color="green">039</FONT>     * interface is to abstract from the concrete declaration format.<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;/p&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     *<a name="line.41"></a>
<FONT color="green">042</FONT>     * @since 1.3<a name="line.42"></a>
<FONT color="green">043</FONT>     * @author &lt;a<a name="line.43"></a>
<FONT color="green">044</FONT>     * href="http://commons.apache.org/configuration/team-list.html"&gt;Commons<a name="line.44"></a>
<FONT color="green">045</FONT>     * Configuration team&lt;/a&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     * @version $Id: BeanDeclaration.java 1208756 2011-11-30 20:37:32Z oheger $<a name="line.46"></a>
<FONT color="green">047</FONT>     */<a name="line.47"></a>
<FONT color="green">048</FONT>    public interface BeanDeclaration<a name="line.48"></a>
<FONT color="green">049</FONT>    {<a name="line.49"></a>
<FONT color="green">050</FONT>        /**<a name="line.50"></a>
<FONT color="green">051</FONT>         * Returns the name of the {@code BeanFactory} that should be used<a name="line.51"></a>
<FONT color="green">052</FONT>         * for creating the bean instance. This can be &lt;b&gt;null&lt;/b&gt;, then a default<a name="line.52"></a>
<FONT color="green">053</FONT>         * factory will be used.<a name="line.53"></a>
<FONT color="green">054</FONT>         *<a name="line.54"></a>
<FONT color="green">055</FONT>         * @return the name of the bean factory<a name="line.55"></a>
<FONT color="green">056</FONT>         */<a name="line.56"></a>
<FONT color="green">057</FONT>        String getBeanFactoryName();<a name="line.57"></a>
<FONT color="green">058</FONT>    <a name="line.58"></a>
<FONT color="green">059</FONT>        /**<a name="line.59"></a>
<FONT color="green">060</FONT>         * Here an arbitrary object can be returned that will be passed to the bean<a name="line.60"></a>
<FONT color="green">061</FONT>         * factory. Its meaning is not further specified. The purpose of this<a name="line.61"></a>
<FONT color="green">062</FONT>         * additional parameter is to support a further configuration of the bean<a name="line.62"></a>
<FONT color="green">063</FONT>         * factory that can be placed directly at the bean declaration.<a name="line.63"></a>
<FONT color="green">064</FONT>         *<a name="line.64"></a>
<FONT color="green">065</FONT>         * @return a parameter for the bean factory<a name="line.65"></a>
<FONT color="green">066</FONT>         */<a name="line.66"></a>
<FONT color="green">067</FONT>        Object getBeanFactoryParameter();<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>        /**<a name="line.69"></a>
<FONT color="green">070</FONT>         * Returns the name of the bean class, from which an instance is to be<a name="line.70"></a>
<FONT color="green">071</FONT>         * created. This value must be defined unless a default class is provided<a name="line.71"></a>
<FONT color="green">072</FONT>         * for the bean creation operation.<a name="line.72"></a>
<FONT color="green">073</FONT>         *<a name="line.73"></a>
<FONT color="green">074</FONT>         * @return the name of the bean class<a name="line.74"></a>
<FONT color="green">075</FONT>         */<a name="line.75"></a>
<FONT color="green">076</FONT>        String getBeanClassName();<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>        /**<a name="line.78"></a>
<FONT color="green">079</FONT>         * Returns a map with properties that should be initialized on the newly<a name="line.79"></a>
<FONT color="green">080</FONT>         * created bean. The map's keys are the names of the properties; the<a name="line.80"></a>
<FONT color="green">081</FONT>         * corresponding values are the properties' values. The return value can be<a name="line.81"></a>
<FONT color="green">082</FONT>         * &lt;b&gt;null&lt;/b&gt; if no properties should be set.<a name="line.82"></a>
<FONT color="green">083</FONT>         *<a name="line.83"></a>
<FONT color="green">084</FONT>         * @return a map with properties to be initialized<a name="line.84"></a>
<FONT color="green">085</FONT>         */<a name="line.85"></a>
<FONT color="green">086</FONT>        Map&lt;String, Object&gt; getBeanProperties();<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>        /**<a name="line.88"></a>
<FONT color="green">089</FONT>         * Returns a map with declarations for beans that should be set as<a name="line.89"></a>
<FONT color="green">090</FONT>         * properties of the newly created bean. This allows for complex<a name="line.90"></a>
<FONT color="green">091</FONT>         * initialization scenarios: a bean for a bean that contains complex<a name="line.91"></a>
<FONT color="green">092</FONT>         * properties (e.g. other beans) can have nested declarations for defining<a name="line.92"></a>
<FONT color="green">093</FONT>         * these complex properties. The returned map's key are the names of the<a name="line.93"></a>
<FONT color="green">094</FONT>         * properties to initialize. The values are either {@code BeanDeclaration}<a name="line.94"></a>
<FONT color="green">095</FONT>         * implementations or collections thereof. They will be treated like this<a name="line.95"></a>
<FONT color="green">096</FONT>         * declaration (in a* recursive manner), and the resulting beans are<a name="line.96"></a>
<FONT color="green">097</FONT>         * assigned to the corresponding properties.<a name="line.97"></a>
<FONT color="green">098</FONT>         *<a name="line.98"></a>
<FONT color="green">099</FONT>         * @return a map with nested bean declarations<a name="line.99"></a>
<FONT color="green">100</FONT>         */<a name="line.100"></a>
<FONT color="green">101</FONT>        Map&lt;String, Object&gt; getNestedBeanDeclarations();<a name="line.101"></a>
<FONT color="green">102</FONT>    }<a name="line.102"></a>




























































</PRE>
</BODY>
</HTML>
